home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 2 / Apprentice-Release2.iso / Tools / Helpers / UpdateMaker 1.3.4 / UpdateMaker Info < prev   
Encoding:
Text File  |  1994-11-05  |  11.8 KB  |  103 lines  |  [TEXT/ttxt]

  1. Introduction
  2.  
  3. UpdateMaker is an application that can determine the differences between any two Macintosh files, be they applications, documents, system files, or whatever. UpdateMaker documents describe the changes needed to convert one file (called the "old" file, whether it is older or not) into the "new" file. You cannot read UpdateMaker documents, since they are stored in a compact form. However, you can apply the UpdateMaker document to a copy of the "old" file and it will generate an exact copy of the "new" file.
  4.  
  5. Why is this useful? Because UpdateMaker documents can be very much smaller than the files that they apply to, they cost less to send over a computer network or store on a disk. If you wish to send some changes to a large document or a large application to someone who has an older version, sending an UpdateMaker document will cost less than resending the entire document or application. UpdateMaker documents are also more secure in that they can only be used someone who has the "old" file. 
  6.  
  7. Because not everyone who might want to update a file will have a copy of UpdateMaker to apply UpdateMaker documents with, UpdateMaker can also save documents as stand-alone applications. These applications are good for one and only one job – updating the particular file that they were created for. But they can be convenient if you do not know that a copy of UpdateMaker will be available to the receiver of the UpdateMaker document. The stand-alone applications, like UpdateMaker itself , require System 6 or later.
  8.  
  9. Please note that UpdateMaker documents are inherently reliable. They have internal checksums which will detect damage done to them in transit. They also use checksums to ensure that the target file is identical to the "old" file that the update was built for. Updates are therefore guaranteed to either fail or generate a perfect copy of the "new" file that was used to make them, subject only to any special exceptions specified by the author of the update.
  10.  
  11. Before You Start
  12. If you are using anti-viral software such as GateKeeper or SAM which continuously monitors for unusual activity you should turn it off or set up exceptions for UpdateMaker. The UpdateMaker application protects itself against virus infection.
  13.  
  14. Making Updates
  15.  
  16. To make an update file, first open UpdateMaker. Click on Cancel when it asks what UpdateMaker file you would like to open. Then choose New from the File menu, and the Update Specifications dialog will be displayed. Click on Choose Files…  Select the old file that the update is to apply to and click Old File. Then select the new file that the update is to convert the old file into, and click New File.  Click Done once you are satisfied with your choices. Enter any remarks about the update that you would like users to see into the Notes for Users box, then click Make Update and UpdateMaker will start building the update document.
  17.  
  18. This may take some minutes, depending on the size of the files and the extent of the differences between them. UpdateMaker will do the build in the background if you want to use another application while you are waiting. When it is finished, choose Save from the File menu and fill in the Save dialog box. Here is where you can click the Save As Application check-box if you wish to save the document as a stand-alone application.
  19.  
  20. Using Updates
  21.  
  22. To use an update document, simply open it. If you wish to see more information about the document (some of which is rather technical), click the Show Description check-box. When you are ready to apply the update, click Update. Use the dialog to select the file to be updated. UpdateMaker will only show you files of the appropriate type. Click the Update It button. Use the next dialog to select where the updated version is to be put. Note that the old file will not be altered or deleted unless you specifically ask for it to be replaced, and that UpdateMaker will always initially suggest a non-conflicting name in the same folder.
  23.  
  24. Running out of Memory
  25.  
  26. UpdateMaker can require a lot of memory if asked to update large documents – for example, 500K Word documents. It may need space equal to the sum of the sizes of the old file and the UpdateMaker document plus 600K to perform an update, and more to build a new document. If UpdateMaker fails because there is not enough memory, you can allocate more by using the Get Info command under the File menu in the Finder.
  27.  
  28. Expert Build Options
  29.  
  30. The Show Expert Options checkbox in the Update Specifications dialog displays three sets of controls that can be used to override UpdateMaker's normal behaviour. For example, they allow you to generate updates for applications which have been customised by their users (often by recording their name and organisation in the application's startup screen). Do not use these controls unless you understand what they do. The "always copy" options in particular must be used with care, because they override UpdateMaker's normal guarantee that the updated file will be identical to the original "new" file. If you do use these options, UpdateMaker will remember them and recall them the next time you make an update for the same type of file.
  31.  
  32. Technical Details
  33.  
  34. When UpdateMaker builds a new document it first examines the old and the new files. It records their attributes, their resources, and the contents of their data forks (which are treated just like resources). It then generates difference information that specifies which resources should be added, deleted, copied, or modified to make the new file, given the old file. An UpdateMaker document consists of this difference information plus the new file's attributes and the added and modified resources. 
  35.  
  36. UpdateMaker generates 32-bit checksums for every resource that is copied or modified from the original file. It will not allow an update to proceed if these are different. This guarantees that the file generated by an update is identical to the new file that was used to make the update document. However, UpdateMaker only requires those parts of the old file that are actually used to make the new file to be identical with those used to make the update.
  37.  
  38. SIZE 0 resources are always an exception. Because they are added to applications by the Finder when the user adjusts the preferred memory size, many users will have different SIZE 0's. UpdateMaker therefore defaults to always replacing SIZE 0 resources. The expert options in the Update Specifications dialog allow authors to override this behaviour and always copy the SIZE 0 from the original file without checking it, retaining whatever memory size the user preferred. If you use this option, be sure that the target applications will always have a SIZE 0.
  39.  
  40. The other expert options allow you to force replacement or unchecked copying for other resources or for the data fork. Both of these options allow for the user who has different resources in their old file from those in the old file that was used to build the update. The replacement options are safest as they can only make the update document larger, but they will override any changes that the user has made.
  41.  
  42. The Save As application option simply saves the UpdateMaker document together with a minimum set of  resources needed to turn it into a custom application. 
  43.  
  44. Developers may wish to use a facility in the custom applications that will display an alert, ID 1000, if it is added to the application. The alert will be displayed at startup, before the open file dialog. It should include the standard OK and Cancel buttons, but otherwise may have anything you like in it.
  45.  
  46. UpdateMaker 2.2
  47.  
  48. UpdateMaker 2.2 is an improved descendant of UpdateMaker 1.3.  It features:
  49.  
  50. • Multiple-version updates. UpdateMaker 2.2 updates can convert any one of several "old" files into the  "new" file. For example, one update can change Word 4.0A or Word 4.0B or Word 4.0C into Word 4.0D.
  51.  
  52. • Smaller update files. UpdateMaker 2.2 is generally more intelligent and can track resources that change ID. It also uses a more compact file format. UpdateMaker 2.2 updates are typically 10-20% smaller than their UpdateMaker 1 equivalents. In some cases they can be 50% smaller.
  53.  
  54. • More control. UpdateMaker 2.2 has three resource override lists, including a new copy-if-present override category, plus control over what stand-alone applications name the new file and do with the old file when the update completes.
  55.  
  56. • Better stand-alone applications. UpdateMaker 2.2 applications have a progress bar and a cancel button, support AppleEvents, and can use customised opening and closing dialogs designed by the update author.
  57.  
  58. • Saves and reads BinHex format. UpdateMaker 2.2 will directly read and write files in this popular form for network distribution.
  59.  
  60. • International updaters. UpdateMaker 2.2 can make updaters correctly localised in nine European languages, plus Japanese.
  61.  
  62. • Code extensions. UpdateMaker 2.2 supports custom code extensions for dealing with unusual updating problems. A sample extension for decompressing VISEd applications is provided.
  63.  
  64. • Numerous other minor user interface improvements, such as version number displays and user note editing during and after a build.
  65.  
  66. • Not shareware. UpdateMaker 2 is a fully supported commercial application, with a manual.
  67.  
  68.  
  69. Ordering and pricing
  70.  
  71. Send VISA, U.S cheque or money order for US$220 plus $5 post and packing per copy to:
  72.  
  73.   ADInstruments,
  74.   2225 Grant Rd,
  75.   Suite 4,
  76.   Los Altos, CA 94024
  77.   United States.
  78.  
  79.  Telephone (415) 964 2878
  80.  Fax (415) 964 2886
  81.  
  82. Shareware
  83.  
  84. UpdateMaker is © 1994 by Analog Digital Instruments Ltd.  No warranty, either express or implied, is made with respect to its performance or fitness for purpose. You are permitted, nay, encouraged, to copy and distribute this software, provided that this notice is preserved on all copies. 
  85.  
  86. UpdateMaker 1 is shareware. If you make practical use of it beyond just trying it out, you should send us US$10 if you are only making private use of it, and US$50 if you wish to make commercial use of it.
  87. This charge is for a single-user license and entitles you to distribute stand-alone updates to others. Large institutions who would like site licenses to cover many users and locations should contact us. Please send cheques to:
  88.    AD Instruments,
  89.    Suite 4, 2225 Grant Rd,
  90.    Los Altos  CA94024,
  91.    United States.
  92.  
  93. This will entitle you to feel smug for at least a week afterwards. This address cannot provide support for UpdateMaker 1. If you have questions about UpdateMaker 1, please use electronic mail to the Internet address below. We will fix bugs (if possible...), and the resulting new versions of UpdateMaker 1 will be distributed from time to time over the Internet. However we cannot at present afford to notify users individually of this, other than by e-mail.
  94.  
  95. This software may not be sold or distributed for profit, or included with other software which is sold or distributed for profit, without the permission of the author. Offenders will be proceeded against in the High Court by mesne process and writ of ne exeat regno with barratry and replevin, notwithstanding the dicta of Wright LJ in Rainham Chemical Works Ltd v Belvedere Fish Guano Co  [1921] 2 AC 465, or s 13(4) of the Imprisonment for Debt Abolition Act 1874.
  96.  
  97. ADInstruments
  98.  
  99. ADInstruments are the manufacturers of MacLab™, a scientific data recording and analysis system for the Apple Macintosh series. MacLab™ comes in two, four and eight-channel forms, with Scope software which emulates a two-channel digital oscilloscope and Chart software to emulate an eight-channel chart recorder. Other packages include the Peaks chromatography workstation and the ElectroLab electrochemistry system. Specialised front-end amplifier modules are also available, such as the Bio Amplifier for human measurement applications and the Bridge Amplifier for force transducers. All MacLab software shares a consistent user interface and closely adheres to the Macintosh human interface standards.
  100.  
  101.  
  102. Michael™ Hamel, April 1994
  103. anadig@otago.ac.nz